Skip to content

Conversation

@newhoggy
Copy link
Contributor

Pull Request

Description

This PR enhances the project's CI workflow to properly reflect dependency status and adds comprehensive documentation including a README with project overview and status badges.

Type of Change

  • Documentation update
  • Bug fix (non-breaking change which fixes an issue)

Changes Made

  • Fixed the cabal-outdated workflow to properly fail when outdated dependencies are detected, ensuring the dependency status badge accurately reflects the build state
  • Added comprehensive README.md with project overview, installation instructions, and status badges for dependency health and CI status
  • Updated copyright years from 2021-2023/2024 to 2021-2025 across LICENSE, NOTICE, and README files

Testing

  • All existing tests pass
  • New tests added for new functionality
  • Manual testing performed

Additional Notes

The cabal-outdated workflow now correctly exits with status code 1 when outdated dependencies are found, which will make the dependency status badge show a failure state instead of incorrectly showing success. This provides better visibility into the actual dependency health of the project.

The new README provides essential project information for users and contributors, including clear installation instructions for both Cabal and Stack package managers.

@newhoggy newhoggy force-pushed the newhoggy/cabal-dependencies-outdated-badge branch from 63ed961 to 786d7ae Compare October 24, 2025 23:52
@newhoggy newhoggy force-pushed the newhoggy/cabal-dependencies-outdated-badge branch from 786d7ae to 780336b Compare October 28, 2025 12:28
…cted

This change ensures that Outdated dependency badges accurately reflect the
build status
@newhoggy newhoggy force-pushed the newhoggy/cabal-dependencies-outdated-badge branch from 780336b to 02ddb57 Compare October 28, 2025 12:38
@newhoggy newhoggy merged commit f8a8570 into main Oct 28, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants